<!DOCTYPE HTML>

<html lang="en">
<head>

<title>AclService (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="AclService (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="AclService.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="AclService.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="AclService.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.acls.model</a></div>
<h2 title="Interface AclService" class="title">Interface AclService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="MutableAclService.html" title="interface in org.springframework.security.acls.model">MutableAclService</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../jdbc/JdbcAclService.html" title="class in org.springframework.security.acls.jdbc">JdbcAclService</a></code>, <code><a href="../jdbc/JdbcMutableAclService.html" title="class in org.springframework.security.acls.jdbc">JdbcMutableAclService</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">AclService</span></pre>
<div class="block">Provides retrieval of <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> instances.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AclService.html#findChildren(org.springframework.security.acls.model.ObjectIdentity)">findChildren</a></span>&#8203;(<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&nbsp;parentIdentity)</code></th>
<td class="colLast">
<div class="block">Locates all object identities that use the specified parent.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AclService.html#readAclById(org.springframework.security.acls.model.ObjectIdentity)">readAclById</a></span>&#8203;(<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Same as <a href="AclService.html#readAclsById(java.util.List)"><code>readAclsById(List)</code></a> except it returns only a single Acl.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AclService.html#readAclById(org.springframework.security.acls.model.ObjectIdentity,java.util.List)">readAclById</a></span>&#8203;(<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&nbsp;object,
java.util.List&lt;<a href="Sid.html" title="interface in org.springframework.security.acls.model">Sid</a>&gt;&nbsp;sids)</code></th>
<td class="colLast">
<div class="block">Same as <a href="AclService.html#readAclsById(java.util.List,java.util.List)"><code>readAclsById(List, List)</code></a> except it returns only a single Acl.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>,&#8203;<a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AclService.html#readAclsById(java.util.List)">readAclsById</a></span>&#8203;(java.util.List&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&gt;&nbsp;objects)</code></th>
<td class="colLast">
<div class="block">Obtains all the <tt>Acl</tt>s that apply for the passed <tt>Object</tt>s.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>,&#8203;<a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AclService.html#readAclsById(java.util.List,java.util.List)">readAclsById</a></span>&#8203;(java.util.List&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&gt;&nbsp;objects,
java.util.List&lt;<a href="Sid.html" title="interface in org.springframework.security.acls.model">Sid</a>&gt;&nbsp;sids)</code></th>
<td class="colLast">
<div class="block">Obtains all the <tt>Acl</tt>s that apply for the passed <tt>Object</tt>s, but only
for the security identifies passed.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="findChildren(org.springframework.security.acls.model.ObjectIdentity)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>findChildren</h4>
<pre class="methodSignature">java.util.List&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&gt;&nbsp;findChildren&#8203;(<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&nbsp;parentIdentity)</pre>
<div class="block">Locates all object identities that use the specified parent. This is useful for
administration tools.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parentIdentity</code> - to locate children of</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the children (or <tt>null</tt> if none were found)</dd>
</dl>
</li>
</ul>
<a id="readAclById(org.springframework.security.acls.model.ObjectIdentity)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>readAclById</h4>
<pre class="methodSignature"><a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a>&nbsp;readAclById&#8203;(<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&nbsp;object)
         throws <a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></pre>
<div class="block">Same as <a href="AclService.html#readAclsById(java.util.List)"><code>readAclsById(List)</code></a> except it returns only a single Acl.
<p>
This method should not be called as it does not leverage the underlying
implementation's potential ability to filter <tt>Acl</tt> entries based on a
<a href="Sid.html" title="interface in org.springframework.security.acls.model"><code>Sid</code></a> parameter.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - to locate an <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> for the requested <a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a> (never
<tt>null</tt>)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></code> - if an <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> was not found for the requested
<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a></dd>
</dl>
</li>
</ul>
<a id="readAclById(org.springframework.security.acls.model.ObjectIdentity,java.util.List)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>readAclById</h4>
<pre class="methodSignature"><a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a>&nbsp;readAclById&#8203;(<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&nbsp;object,
                java.util.List&lt;<a href="Sid.html" title="interface in org.springframework.security.acls.model">Sid</a>&gt;&nbsp;sids)
         throws <a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></pre>
<div class="block">Same as <a href="AclService.html#readAclsById(java.util.List,java.util.List)"><code>readAclsById(List, List)</code></a> except it returns only a single Acl.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - to locate an <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> for</dd>
<dd><code>sids</code> - the security identities for which <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> information is required
(may be <tt>null</tt> to denote all entries)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> for the requested <a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a> (never
<tt>null</tt>)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></code> - if an <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> was not found for the requested
<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a></dd>
</dl>
</li>
</ul>
<a id="readAclsById(java.util.List)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>readAclsById</h4>
<pre class="methodSignature">java.util.Map&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>,&#8203;<a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a>&gt;&nbsp;readAclsById&#8203;(java.util.List&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&gt;&nbsp;objects)
                                              throws <a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></pre>
<div class="block">Obtains all the <tt>Acl</tt>s that apply for the passed <tt>Object</tt>s.
<p>
The returned map is keyed on the passed objects, with the values being the
<tt>Acl</tt> instances. Any unknown objects will not have a map key.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objects</code> - the objects to find <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> information for</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map with exactly one element for each <a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a> passed as an
argument (never <tt>null</tt>)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></code> - if an <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> was not found for each requested
<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a></dd>
</dl>
</li>
</ul>
<a id="readAclsById(java.util.List,java.util.List)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readAclsById</h4>
<pre class="methodSignature">java.util.Map&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>,&#8203;<a href="Acl.html" title="interface in org.springframework.security.acls.model">Acl</a>&gt;&nbsp;readAclsById&#8203;(java.util.List&lt;<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model">ObjectIdentity</a>&gt;&nbsp;objects,
                                                     java.util.List&lt;<a href="Sid.html" title="interface in org.springframework.security.acls.model">Sid</a>&gt;&nbsp;sids)
                                              throws <a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></pre>
<div class="block">Obtains all the <tt>Acl</tt>s that apply for the passed <tt>Object</tt>s, but only
for the security identifies passed.
<p>
Implementations <em>MAY</em> provide a subset of the ACLs via this method although
this is NOT a requirement. This is intended to allow performance optimisations
within implementations. Callers should therefore use this method in preference to
the alternative overloaded version which does not have performance optimisation
opportunities.
</p>
<p>
The returned map is keyed on the passed objects, with the values being the
<tt>Acl</tt> instances. Any unknown objects (or objects for which the interested
<tt>Sid</tt>s do not have entries) will not have a map key.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objects</code> - the objects to find <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> information for</dd>
<dd><code>sids</code> - the security identities for which <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> information is required
(may be <tt>null</tt> to denote all entries)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a map with exactly one element for each <a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a> passed as an
argument (never <tt>null</tt>)</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="NotFoundException.html" title="class in org.springframework.security.acls.model">NotFoundException</a></code> - if an <a href="Acl.html" title="interface in org.springframework.security.acls.model"><code>Acl</code></a> was not found for each requested
<a href="ObjectIdentity.html" title="interface in org.springframework.security.acls.model"><code>ObjectIdentity</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="AclService.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="AclService.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="AclService.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040e139eee997cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
